Skip to content

Generate Release Notes workflow#146

Open
tmikula-dev wants to merge 6 commits into
masterfrom
feature/145-implement-generate-release-notes-workflow
Open

Generate Release Notes workflow#146
tmikula-dev wants to merge 6 commits into
masterfrom
feature/145-implement-generate-release-notes-workflow

Conversation

@tmikula-dev
Copy link
Copy Markdown
Collaborator

@tmikula-dev tmikula-dev commented May 22, 2026

Overview

This pull request introduces new processes and templates to standardize and automate release note management in the repository. It adds a pull request template that prompts contributors to provide release notes, and sets up GitHub Actions workflows to check for release notes in PRs and to automate the drafting of releases, including tag validation and release note generation.

The part of the solution was that I created a no RN label, that can turn off the RN checker, when the change does not need a release note (dependencies bump...)

Release Notes

  • Adding Release Notes Generator workflow
  • Adding Release Notes checker worfkflow
  • Adding Pull Request template

Related

Closes #145

@tmikula-dev tmikula-dev requested a review from wajda May 22, 2026 09:12
@tmikula-dev tmikula-dev self-assigned this May 22, 2026
@tmikula-dev tmikula-dev added the enhancement New feature or request label May 22, 2026
@tmikula-dev tmikula-dev requested a review from miroslavpojer May 22, 2026 12:18
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
release-notes-title: "## [Rr]elease [Nn]otes"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This setup title change should be applied after release.
Before it, there is a risk that next rls will miss old formatted release notes.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not understand, there are no old formatted RNs, since this is the first implementation of the generator in the repository. Or can you please explain your point more? Thank you.

@sonarqubecloud
Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implement Generate Release Notes Workflow

2 participants